package org.jsola.contract.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.contract.dto.TemplateVariableAddDTO;
import org.jsola.contract.dto.TemplateVariableBatchDTO;
import org.jsola.contract.dto.TemplateVariableUpdateDTO;
import org.jsola.contract.query.TemplateVariableQuery;
import org.jsola.contract.vo.TemplateVariableListVO;
import org.jsola.contract.vo.TemplateVariableVO;
import org.jsola.core.Page;
import org.jsola.core.Result;

import java.util.List;

/**
 * 合同模板关联变量
 *
 * @author JanusMix
 */
@Api(tags = "contract-合同模板关联变量")
public interface ITemplateVariableControllerAPI {

    /**
     * 新增合同模板关联变量
     * @param templateVariableAddDTO 合同模板关联变量新增实体
     * @return 合同模板关联变量展示对象
     */
    @ApiOperation(value = "新增合同模板关联变量")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "templateVariableAddDTO", dataType = "TemplateVariableAddDTO", value = "新增合同模板关联变量", paramType = "body")
    })
    Result<TemplateVariableVO> save(TemplateVariableAddDTO templateVariableAddDTO);


    /**
     * 修改合同模板关联变量
     * @param templateVariableUpdateDTO 合同模板关联变量
     * @return 更新数量
     */
    @ApiOperation(value = "修改合同模板关联变量")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "templateVariableUpdateDTO", dataType = "TemplateVariableUpdateDTO", value = "修改合同模板关联变量", paramType = "body")
    })
    Result<Integer> update(TemplateVariableUpdateDTO templateVariableUpdateDTO);

    /**
     * 批量编辑、新增、删除合同模板关联变量
     * @param templateVariableBatchDTO 要操作的合同模板关联变量
     * @return 操作之后的全部合同模板关联变量
     */
    @ApiOperation(value = "批量编辑、新增、删除合同模板关联变量")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "templateVariableBatchDTO", dataType = "TemplateVariableBatchDTO", value = "要操作的字段数据", paramType = "body")
    })
    Result batch(TemplateVariableBatchDTO templateVariableBatchDTO);



    /**
     * 删除单个合同模板关联变量，彻底删除
     * @param templateVariableId 合同模板关联变量id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个合同模板关联变量，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "templateVariableId", dataType = "Long", value = "合同模板关联变量id", paramType = "path")
    })
    Result<Integer> delete(Long templateVariableId);


    /**
     * 批量删除合同模板关联变量，彻底删除
     * @param templateVariableIds 合同模板关联变量id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除合同模板关联变量，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "templateVariableIds", dataType = "Long[]", value = "合同模板关联变量id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(Long[] templateVariableIds);


    /**
     * 根据合同模板关联变量id查询合同模板关联变量详情
     * @param templateVariableId 合同模板关联变量id
     * @return 合同模板关联变量详情
     */
    @ApiOperation(value="根据合同模板关联变量id查询合同模板关联变量详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "templateVariableId", dataType = "Long", value = "合同模板关联变量id", paramType = "path")
    })
    Result<TemplateVariableVO> findById(Long templateVariableId);


    /**
     * 查询合同模板关联变量
     * @param templateVariableQuery 合同模板关联变量查询参数
     * @return page
     */
    @ApiOperation(value="查询合同模板关联变量")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "templateVariableQuery", dataType = "TemplateVariableQuery", value = "合同模板关联变量查询参数", paramType = "query")
    })
    Result<List<TemplateVariableListVO>> listAll(TemplateVariableQuery templateVariableQuery);


     /**
     * 分页查询合同模板关联变量
     * @param templateVariableQuery 合同模板关联变量查询参数
     * @return page
     */
    @ApiOperation(value="分页查询合同模板关联变量")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "templateVariableQuery", dataType = "TemplateVariableQuery", value = "合同模板关联变量查询参数", paramType = "query")
    })
    Result<Page<TemplateVariableListVO>> page(TemplateVariableQuery templateVariableQuery);


}

